Freshdesk Scope
AutomatR.FreshDesk.Activitys.FreshDeskScope
The "Freshdesk Scope" activity in AutomatR is designed to allow access to Freshdesk user accounts based on API authentication keys. This activity establishes a scope for executing Freshdesk-related activities within the workflow, providing a secure and authenticated connection to the Freshdesk account.
Properties
| Name | Description |
|---|---|
| Input | |
| API Key | Specifies the API key associated with the Freshdesk user account. It is a required input for authentication and accessing Freshdesk resources. String variables containing the API key. |
| Domain URL | Specifies the domain URL for the Freshdesk account. It is a required input, defining the URL of the Freshdesk instance to connect to. String variables containing the domain URL. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get All Agents" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
How to use:
- Drag and drop the "Freshdesk Scope" activity onto the workflow.
- Configure the properties by specifying the API key and domain URL for the Freshdesk account.
- Optionally, configure the delay.
- Place Freshdesk-related activities inside the "Freshdesk Scope" activity to perform operations within the authenticated context.
- Execute the workflow to interact with Freshdesk resources securely.
Example: Consider an example where the "Freshdesk Scope" activity is used to establish a scope for Freshdesk-related activities:
Freshdesk Scope:
Display Name: "Authenticate and Access Freshdesk"
API Key: "your_api_key_here"
Domain URL: "https://yourdomain.freshdesk.com/"
Delay: 0
(Inside the scope, place Freshdesk-related activities)
In this example, the activity authenticates with Freshdesk using the provided API key and domain URL. Any activities placed inside this scope can securely access Freshdesk resources without the need to reauthenticate for each operation.